proto(sql): add Redpanda SQL dataplane API#2467
Conversation
|
The latest Buf updates on your PR. Results from workflow Buf CI / validate (pull_request).
|
| repeated Row rows = 2; | ||
| // True if the server row cap fired before the result set was | ||
| // exhausted. | ||
| bool truncated = 3; |
There was a problem hiding this comment.
my preference here is what goland does and autopaginates so if server limit is 500 we do offset/limit pagination. maybe thats a follow up might not be performant on big datasets
There was a problem hiding this comment.
Can you expand on this a little bit? it is the idea to have a pagination mechanism (page_token, etc) and only paginate when?
There was a problem hiding this comment.
so in jetbrains datagrip probably other tools too, if you dont set a limit it will return only the first 500 results and gives you a next page token instead of truncating.
This probably for the backend but we need to handle the user asking for like 100000 records or something, so maybe we parse the query?
Adds the dataplane API surface for the in-Console SQL editor backed by Oxla over the Postgres wire protocol. The service covers catalog and table introspection (ListCatalogs, ListDatabases, ListTables, DescribeTable) and single-statement execution (ExecuteQuery) with a server-side row cap. Lands in v1alpha3 since the surface is expected to evolve before GA. Auth flows pass through the caller's Cloud OIDC bearer to Oxla, which requires adding API_OXLA to the shared API enum.
| // Optional SQL LIKE pattern matched against table name (e.g. | ||
| // 'orders_%'). When unset, all tables in the catalog are returned. | ||
| optional string filter = 4 [ | ||
| (buf.validate.field).string.max_len = 255, | ||
| (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {description: "Optional SQL LIKE pattern matched against table name (e.g. 'orders_%')."} | ||
| ]; |
|
Addressed the first comments and generated the files in https://github.com/redpanda-data/console/compare/521844b3f3c32dfd112cdc5bb87c803a5b7398ae..02f30c60f192c23b76633f687809ffaa9d15822e |
2 participants
Adds the dataplane API surface for the
in-Console SQL editor backed by Oxla over
the Postgres wire protocol. The service
covers catalog and table introspection
(ListCatalogs, ListDatabases, ListTables,
DescribeTable) and single-statement
execution (ExecuteQuery) with a
server-side row cap. Lands in v1alpha3
since the surface is expected to evolve
before GA.
Auth flows pass through the caller's
Cloud OIDC bearer to Oxla, which requires
adding API_OXLA to the shared API enum.